Add automatic loading indicator to show processing #129
+1,068
−2,202
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…d by Luigi init callback, added config params for completely disabling the indicator and for disabling auto-hide feature, added LuigiClient methods for show and hide, updated externalExampleHtml to use Fundamental-UI and LuigiClient and added a demo indicator there
maxmarkus
requested review from
antiheld,
bszwarc,
dariadomagala-sap,
hardl,
jesusreal,
kazydek and
klaudiagrz
as code owners
maxmarkus
requested review from
kwiatekus,
pekura,
tomekpapiernik and
y-kkamil
as code owners
klaudiagrz
reviewed
Oct 8, 2018
docs/navigation-configuration.md
Outdated
| @@ -73,6 +73,8 @@ window.Luigi.setConfig({ | |||
| - **context** sends the specified object as context to the view. Use this parameter in combination with the dynamic **pathSegment** to receive the context through the context listeners of **Luigi client**. This is an alternative to using the dynamic value in the **viewUrl**. | |||
| - **defaultChildNode** sets the child node that Luigi activates automatically if the current node has no **viewUrl** defined. Provide **pathSegment** of the child node you want to activate as a string. | |||
| - **isolateView** renders the view in a new frame when you enter and leave the Node. This setting overrides the same-domain frame re-usage. The **isolateView** is disabled by default. | |||
| - **loadingIndicator.enabled** shows a loading indicator when switching between micro front-ends. Super fast micro front-ends might want to disable this feature. The **loadingIndicator.loadingIndicator** is enabled by default. | |||
There was a problem hiding this comment.
- ...
when you switch between micro front-ends. - "Super fast micro front-ends might want to disable this feature." -> Super fast micro front-ends are not humans so they cannot literally "want" anything. Please paraphrase.
There was a problem hiding this comment.
Something like "If you have a super fast micro frontend, you can disable this feature to prevent loading indicator flickering."
There was a problem hiding this comment.
Just two corrections:
front-endas in the rest of the documentprevent the flickering of the loading indicator.sounds better imho
docs/navigation-configuration.md
Outdated
| @@ -73,6 +73,8 @@ window.Luigi.setConfig({ | |||
| - **context** sends the specified object as context to the view. Use this parameter in combination with the dynamic **pathSegment** to receive the context through the context listeners of **Luigi client**. This is an alternative to using the dynamic value in the **viewUrl**. | |||
| - **defaultChildNode** sets the child node that Luigi activates automatically if the current node has no **viewUrl** defined. Provide **pathSegment** of the child node you want to activate as a string. | |||
| - **isolateView** renders the view in a new frame when you enter and leave the Node. This setting overrides the same-domain frame re-usage. The **isolateView** is disabled by default. | |||
| - **loadingIndicator.enabled** shows a loading indicator when switching between micro front-ends. Super fast micro front-ends might want to disable this feature. The **loadingIndicator.loadingIndicator** is enabled by default. | |||
| - **loadingIndicator.hideAutomatically** disables automatic hiding of the loading indicator. Use `LuigiClient.uxManager().hideLoadingIndicator()` to hide it manually in your micro front-end during startup. The **loadingIndicator.hideAutomatically** is enabled by default. | |||
There was a problem hiding this comment.
the automatic hidingduring the startup.
docs/ux-manager.md
Outdated
| - **removeBackdrop()** removes the backdrop. | ||
| - **showLoadingIndicator()** adds a backdrop with a loading indicator for the micro front-end frame |
klaudiagrz
approved these changes
Oct 8, 2018
jesusreal
suggested changes
Oct 8, 2018
core/examples/luigi-sample-angular/e2e/tests/luigi-client-features.spec.js
Show resolved
Hide resolved
jesusreal
approved these changes
Oct 9, 2018
|
Docu for navigation-configuration.md and ux-manager.md got updated after approval, please check again @klaudiagrz |
klaudiagrz
reviewed
Oct 10, 2018
docs/ux-manager.md
Outdated
| - **removeBackdrop()** removes the backdrop. | ||
| - **showLoadingIndicator()** adds a backdrop with a loading indicator for the micro front-end frame. This overrides the `loadingIndicator.enabled` setting. |
There was a problem hiding this comment.
loadingIndicator.enabled -> please make it bold as with the rest of the parameters
stanleychh
pushed a commit
to stanleychh/luigi
that referenced
this pull request
Dec 30, 2021
* Implemented loading indicator to automatically show and hide triggered by Luigi init callback, added config params for completely disabling the indicator and for disabling auto-hide feature, added LuigiClient methods for show and hide, updated externalExampleHtml to use Fundamental-UI and LuigiClient and added a demo indicator there * added e2e tests for loading indicator * added unit tests to check showLoadingIndicator value, added documentation * manually applied prettier * docu rephrasing * docu updates * refactoring based on PR comments * added wait timeout again to prevent iframe selection failure * extended loading indicator documentation * small docu update
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
LuigiClient.uxManager().showLoadingIndicator()andLuigiClient.uxManager().hideLoadingIndicator()Resolves #100 and #114